/**
 * Copyright 2008 Matthew Purland (m.purland@gmail.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.variance;

import org.variance.version.RevisionTransaction;

/**
 * The main runtime inferface between a Java application and Variance.
 *
 * Idea closely related to org.hibernate.Session
 *
 * @author Matthew Purland
 */
public interface VarianceSession {

    /**
     * End the <code>VarianceSession</code> by disconnecting from the
     * underlying data source. All associated transactions will be void after
     * closing the session.
     */
    void close();

    /**
     * Begin a unit of work. This will return the associated
     * <code>RevisionTransaction</code> and run the begin method.
     *
     * @return the associated <code>RevisionTransaction</code> associated with
     *         the session.
     */
    RevisionTransaction beginTransaction();

    /**
     * Get the <code>RevisionTransaction</code> instance associated with this
     * session.
     *
     * @return a RevisionTransaction instance associated with the session.
     */
    RevisionTransaction getTransaction();
}
